Skip to content

chore: separate benchmarks into a distinct CI job#3873

Open
maxrjones wants to merge 2 commits intozarr-developers:mainfrom
maxrjones:benchmark-smoke-test
Open

chore: separate benchmarks into a distinct CI job#3873
maxrjones wants to merge 2 commits intozarr-developers:mainfrom
maxrjones:benchmark-smoke-test

Conversation

@maxrjones
Copy link
Copy Markdown
Member

This PR changes the CI workflows such that the benchmarking test suite is not run on every environment in the matrix.

What changed

  • Add --ignore tests/benchmarks to run-coverage and run-coverage-html hatch scripts so the main test matrix no longer runs benchmark tests
  • Add a benchmarks job to the test workflow that runs benchmarks in parallel with the other test jobs
  • test-complete gates on the new benchmarks job

Motivation

Benchmark tests (especially sharded morton indexing) take 15-22s each and dominate wall time when included in the main test suite. Running them as a separate parallel job avoids blocking the test matrix while still catching breakage on every PR. The assumption here is that these tests are not necessary to run on every OS and dependency set.

TODO:

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/user-guide/*.md
  • Changes documented as a new file in changes/
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

@github-actions github-actions bot added the needs release notes Automatically applied to PRs which haven't added release notes label Apr 5, 2026
@maxrjones maxrjones changed the title chore: separate benchmarks into a separate job chore: separate benchmarks into a distinct CI job Apr 5, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.91%. Comparing base (dd86ac7) to head (5fefea8).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3873   +/-   ##
=======================================
  Coverage   92.91%   92.91%           
=======================================
  Files          86       86           
  Lines       10709    10709           
=======================================
  Hits         9950     9950           
  Misses        759      759           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@maxrjones maxrjones marked this pull request as ready for review April 6, 2026 01:30
@maxrjones maxrjones requested a review from d-v-b April 6, 2026 01:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs release notes Automatically applied to PRs which haven't added release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant